Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Addon A11y: Add typesVersions support for TypeScript definitions in a11y package #30005

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Dec 10, 2024

Closes #

What I did

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This pull request has been released as version 0.0.0-pr-30005-sha-ba51dda0. Try it out in a new sandbox by running npx [email protected] sandbox or in an existing project with npx [email protected] upgrade.

More information
Published version 0.0.0-pr-30005-sha-ba51dda0
Triggered by @valentinpalkovic
Repository storybookjs/storybook
Branch valentin/fix-type-issue-for-older-typescript-configurations
Commit ba51dda0
Datetime Tue Dec 10 14:54:19 UTC 2024 (1733842459)
Workflow run 12258717166

To request a new release of this pull request, mention the @storybookjs/core team.

core team members can create a new canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=30005

name before after diff z %
createSize 0 B 0 B 0 B - -
generateSize 77.7 MB 77.7 MB 0 B 1.27 0%
initSize 133 MB 133 MB 0 B 1.11 0%
diffSize 55.1 MB 55.1 MB 0 B 1.11 0%
buildSize 6.87 MB 6.87 MB 0 B 0.58 0%
buildSbAddonsSize 1.51 MB 1.51 MB 0 B 1.14 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 1.86 MB 1.86 MB 0 B 1.36 0%
buildSbPreviewSize 0 B 0 B 0 B - -
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 3.57 MB 3.57 MB 0 B 1.29 0%
buildPreviewSize 3.3 MB 3.3 MB 0 B 0.53 0%
testBuildSize 0 B 0 B 0 B - -
testBuildSbAddonsSize 0 B 0 B 0 B - -
testBuildSbCommonSize 0 B 0 B 0 B - -
testBuildSbManagerSize 0 B 0 B 0 B - -
testBuildSbPreviewSize 0 B 0 B 0 B - -
testBuildStaticSize 0 B 0 B 0 B - -
testBuildPrebuildSize 0 B 0 B 0 B - -
testBuildPreviewSize 0 B 0 B 0 B - -
name before after diff z %
createTime 8.6s 7.5s -1s -62ms -0.2 -14.1%
generateTime 22.6s 20.1s -2s -501ms -0.17 -12.4%
initTime 15.8s 13.5s -2s -364ms -0.11 -17.5%
buildTime 10.1s 7.8s -2s -364ms -1.75 🔰-30.3%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 4.5s 4.4s -182ms -1.15 -4.1%
devManagerResponsive 3.5s 3.3s -214ms -1.15 -6.4%
devManagerHeaderVisible 509ms 481ms -28ms -1.33 🔰-5.8%
devManagerIndexVisible 540ms 546ms 6ms -0.99 1.1%
devStoryVisibleUncached 1.7s 1.2s -543ms -1.42 🔰-43.3%
devStoryVisible 539ms 508ms -31ms -1.34 🔰-6.1%
devAutodocsVisible 450ms 456ms 6ms -1.09 1.3%
devMDXVisible 472ms 449ms -23ms -0.98 -5.1%
buildManagerHeaderVisible 498ms 527ms 29ms -0.69 5.5%
buildManagerIndexVisible 580ms 609ms 29ms -0.75 4.8%
buildStoryVisible 456ms 485ms 29ms -0.67 6%
buildAutodocsVisible 414ms 403ms -11ms -0.9 -2.7%
buildMDXVisible 407ms 381ms -26ms -1.27 🔰-6.8%

Greptile Summary

Based on the provided information, I'll create a concise summary of the pull request changes:

Added TypeScript version support in the a11y addon package.json to ensure proper type definitions across different TypeScript versions.

  • Added typesVersions field in code/addons/a11y/package.json to support TypeScript module resolution
  • Configured type definitions for both main package (dist/index.d.ts) and preview module (dist/preview.d.ts)
  • Maintained backward compatibility with existing exports configuration
  • Aligned implementation with standard TypeScript module resolution patterns

The changes are focused on improving TypeScript support while maintaining the existing functionality of the a11y addon.

Copy link

nx-cloud bot commented Dec 10, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit d9eeb21. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@valentinpalkovic valentinpalkovic changed the title Add typesVersions support for TypeScript definitions in a11y package Addon A11y: Add typesVersions support for TypeScript definitions in a11y package Dec 10, 2024
@valentinpalkovic valentinpalkovic marked this pull request as ready for review December 11, 2024 09:19
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile

code/addons/a11y/package.json Show resolved Hide resolved
@valentinpalkovic valentinpalkovic merged commit 53fa387 into next Dec 11, 2024
59 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/fix-type-issue-for-older-typescript-configurations branch December 11, 2024 10:24
@yannbf yannbf added the needs qa Indicates that this needs manual QA during the upcoming minor/major release label Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal needs qa Indicates that this needs manual QA during the upcoming minor/major release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants